POST
/
1
/
indexes
/
{indexName}
/
query
C#
// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.SearchSingleIndexAsync<Hit>(
  "<YOUR_INDEX_NAME>",
  new SearchParams(
    new SearchParamsObject
    {
      Query = "myQuery",
      FacetFilters = new FacetFilters(
        new List<FacetFilters> { new FacetFilters("tags:algolia") }
      ),
    }
  )
);
// >LOG
{
  "abTestID": 123,
  "abTestVariantID": 2,
  "aroundLatLng": "40.71,-74.01",
  "automaticRadius": "<string>",
  "exhaustive": {
    "facetsCount": true,
    "facetValues": true,
    "nbHits": true,
    "rulesMatch": true,
    "typo": true
  },
  "appliedRules": [
    {}
  ],
  "exhaustiveFacetsCount": true,
  "exhaustiveNbHits": true,
  "exhaustiveTypo": true,
  "facets": {
    "category": {
      "food": 1,
      "tech": 42
    }
  },
  "facets_stats": {},
  "index": "indexName",
  "indexUsed": "indexNameAlt",
  "message": "<string>",
  "nbSortedHits": 20,
  "parsedQuery": "george clo",
  "processingTimeMS": 20,
  "processingTimingsMS": {},
  "queryAfterRemoval": "<string>",
  "redirect": {
    "index": [
      {
        "source": "<string>",
        "dest": "<string>",
        "reason": "<string>",
        "succeed": true,
        "data": {
          "ruleObjectID": "<string>"
        }
      }
    ]
  },
  "renderingContent": {
    "facetOrdering": {
      "facets": {
        "order": [
          "<string>"
        ]
      },
      "values": {}
    },
    "redirect": {
      "url": "<string>"
    },
    "widgets": {
      "banners": [
        {
          "image": {
            "urls": [
              {
                "url": "<string>"
              }
            ],
            "title": "<string>"
          },
          "link": {
            "url": "<string>"
          }
        }
      ]
    }
  },
  "serverTimeMS": 20,
  "serverUsed": "c2-uk-3.algolia.net",
  "userData": {
    "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
    "pluginVersion": "1.6.0"
  },
  "queryID": "a00dbc80a8d13c4565a442e7e2dca80a",
  "_automaticInsights": true,
  "page": 0,
  "nbHits": 20,
  "nbPages": 1,
  "hitsPerPage": 20,
  "hits": [
    {
      "objectID": "test-record-123",
      "_highlightResult": {},
      "_snippetResult": {},
      "_rankingInfo": {
        "filters": 1,
        "firstMatchedWord": 1,
        "geoDistance": 1,
        "geoPrecision": 2,
        "matchedGeoLocation": {
          "lat": 123,
          "lng": 123,
          "distance": 123
        },
        "personalization": {
          "filtersScore": 123,
          "rankingScore": 123,
          "score": 123
        },
        "nbExactWords": 1,
        "nbTypos": 1,
        "promoted": true,
        "proximityDistance": 1,
        "userScore": 123,
        "words": 2,
        "promotedByReRanking": true
      },
      "_distinctSeqID": 123
    }
  ],
  "query": "",
  "params": "query=a&hitsPerPage=20"
}

​
Further reading

Guide

Algolia access control list (ACL)

Guide

Click and conversion events

Guide

Custom ranking

Guide

Dynamic Re-Ranking

Guide

Faceting

Guide

Filtering

Guide

Geo location

Guide

Grouping results

Guide

Handling natural languages

Guide

Highlighting and snippeting

Guide

Ranking criteria

Guide

Relevance

Guide

Replica indices

Guide

Sorting results

Guide

Synonyms

Guide

Typo tolerance

Guide

User tokens

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

Search parameters as query string.

Response

200
application/json

OK

The response is of type object.